Make entity fields required by default #81
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
olivier-thatch
commented
May 7, 2025
Here's an example of a CHANGELOG.md entry: * [#81](https://github.com/ruby-grape/grape-swagger-entity/pull/81): Make entity fields required by default - [@olivier-thatch](https://github.com/olivier-thatch).Generated by 🚫 Danger |
numbata
reviewed
May 7, 2025
There was a problem hiding this comment.
Thanks a lot for this contribution, @olivier-thatch! The changes look generally good, and I appreciate that you not only highlighted this problem, but also suggested a solution. I do have some thoughts on a potential simplification in one of the methods, which I've detailed in a comment below.
olivier-thatch
force-pushed
the
required-by-default
branch
from
0a992e3 to
14455d2
Compare
numbata
reviewed
May 8, 2025
olivier-thatch
force-pushed
the
required-by-default
branch
from
14455d2 to
e017856
Compare
olivier-thatch
force-pushed
the
required-by-default
branch
from
e017856 to
3d70c8b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR changes how grape-swagger-entity determines if an entity field is required or not:
documentation: { required: true/false }is set, use thatiforunlessis not null, assume the parameter is not requiredThis is consistent with how grape-entity renders fields: fields are always exposed unless
iforunlessis provided (cf. https://github.com/ruby-grape/grape-entity?tab=readme-ov-file#conditional-exposure).Closes #80.
This is probably a breaking change, so I understand if you don't want to merge this as is, but it would be nice to be able to opt into this behavior.